Fix build CI failure on MacOS by junqiu-lei · Pull Request #1685 · opensearch-project/k-NN

junqiu-lei · 2024-05-02T23:21:58Z

Description

Fix build CI failure for MacOS. The github CI runner for macos-latest changed to use ARM platform recently, updating to use macos-12 with x86_64 architecture to pass the CI.

Issues Resolved

#1660

Check List

Commits are signed as per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

junqiu-lei · 2024-05-03T00:41:52Z

Currently k-NN native libraries can completely make build in macos-latest CI runner env, the new error occurred in integ test:

»  java.lang.UnsatisfiedLinkError: no opensearchknn_common in java.library.path: [/Users/runner/work/k-NN/k-NN/jni/release]
»  	at java.base/java.lang.ClassLoader.loadLibrary(ClassLoader.java:2678)
»  	at java.base/java.lang.Runtime.loadLibrary0(Runtime.java:830)
»  	at java.base/java.lang.System.loadLibrary(System.java:1890)
»  	at org.opensearch.knn.jni.JNICommons.lambda$static$0(JNICommons.java:26)
»  	at java.base/java.security.AccessController.doPrivileged(Native Method)
»  	at org.opensearch.knn.jni.JNICommons.<clinit>(JNICommons.java:25)
»  	at org.opensearch.knn.index.codec.util.KNNCodecUtil.getFloats(KNNCodecUtil.java:89)
»  	at

jmazanec15 · 2024-05-03T15:13:28Z

.github/workflows/CI.yml

+          sed -i -e 's/__aarch64__/__undefine_aarch64__/g' external/faiss/faiss/utils/distances_simd.cpp
+          sed -i -e 's/pragma message WARN/pragma message /g' external/nmslib/similarity_search/src/distcomp_scalar.cc
+          sed -i -e 's/-march=native/-mcpu=apple-m1/g' external/nmslib/similarity_search/CMakeLists.txt
+          sed -i -e 's/-mcpu=apple-a14/-mcpu=apple-m1/g' external/nmslib/python_bindings/setup.py


we dont use python bindings so this should be unnecessary.

.github/workflows/CI.yml

jmazanec15 · 2024-05-03T15:14:31Z

.github/workflows/CI.yml

+          sed -i -e 's/pragma message WARN/pragma message /g' external/nmslib/similarity_search/src/distcomp_scalar.cc
+          sed -i -e 's/-march=native/-mcpu=apple-m1/g' external/nmslib/similarity_search/CMakeLists.txt
+          sed -i -e 's/-mcpu=apple-a14/-mcpu=apple-m1/g' external/nmslib/python_bindings/setup.py
+          if sysctl -n machdep.cpu.features | grep -i AVX2;


We dont need this if runner is arm

same as below

jmazanec15 · 2024-05-03T15:15:56Z

.github/workflows/CI.yml

+          export CC=/opt/homebrew/opt/llvm/bin/clang
+          export CXX=/opt/homebrew/opt/llvm/bin/clang++
+          cd jni
+          sed -i -e 's/\/usr\/local\/opt\/libomp\//\/opt\/homebrew\/opt\/llvm\//g' cmake/init-faiss.cmake


Can we just add this check in cmake?

jmazanec15 · 2024-05-03T15:17:01Z

.github/workflows/CI.yml

+          export CXX=/opt/homebrew/opt/llvm/bin/clang++
+          cd jni
+          sed -i -e 's/\/usr\/local\/opt\/libomp\//\/opt\/homebrew\/opt\/llvm\//g' cmake/init-faiss.cmake
+          sed -i -e 's/__aarch64__/__undefine_aarch64__/g' external/faiss/faiss/utils/distances_simd.cpp


This should be possible to avoid. In faiss, I think they are building it without patches: facebookresearch/faiss#3411.

jmazanec15 · 2024-05-03T15:17:23Z

.github/workflows/CI.yml

+          cd jni
+          sed -i -e 's/\/usr\/local\/opt\/libomp\//\/opt\/homebrew\/opt\/llvm\//g' cmake/init-faiss.cmake
+          sed -i -e 's/__aarch64__/__undefine_aarch64__/g' external/faiss/faiss/utils/distances_simd.cpp
+          sed -i -e 's/pragma message WARN/pragma message /g' external/nmslib/similarity_search/src/distcomp_scalar.cc


why do we need to switch the WARN message?

jmazanec15 · 2024-05-03T15:17:48Z

.github/workflows/CI.yml

+          sed -i -e 's/\/usr\/local\/opt\/libomp\//\/opt\/homebrew\/opt\/llvm\//g' cmake/init-faiss.cmake
+          sed -i -e 's/__aarch64__/__undefine_aarch64__/g' external/faiss/faiss/utils/distances_simd.cpp
+          sed -i -e 's/pragma message WARN/pragma message /g' external/nmslib/similarity_search/src/distcomp_scalar.cc
+          sed -i -e 's/-march=native/-mcpu=apple-m1/g' external/nmslib/similarity_search/CMakeLists.txt


I think that native should be fine. We shouldnt need this

junqiu-lei · 2024-05-03T16:48:41Z

Thank @jmazanec15 for comments. For the arm setup, I followed steps from k-NN developer guide doc. But currently the it has another new error happened during k-NN run time in integ test when we use the macos-latest.

Signed-off-by: Junqiu Lei <[email protected]>

junqiu-lei · 2024-05-03T17:44:16Z

After we just changed the label to use macos-12(x86_64 architecture) which is used from most recent successful run, the CI on MacOS can be passed. https://github.com/opensearch-project/k-NN/actions/runs/8942266898/job/24564490315?pr=1685

jmazanec15 · 2024-05-03T15:48:29Z

.github/workflows/CI.yml

          brew reinstall gcc
-          export FC=/usr/local/Cellar/gcc/12.2.0/bin/gfortran
+          brew install llvm
+          brew install openblas


I saw this message in logs:

2024-05-03T00:54:26.3237060Z openblas is keg-only, which means it was not symlinked into /opt/homebrew, 2024-05-03T00:54:26.3237780Z because macOS provides BLAS in Accelerate.framework.

Can we skip this?

jmazanec15 · 2024-05-03T15:48:47Z

.github/workflows/CI.yml

+      - name: Build native libraries
        run: |
+          git submodule update --init --recursive
          brew reinstall gcc


If we're using clang, I dont think we need gcc

Signed-off-by: Junqiu Lei <[email protected]> (cherry picked from commit 73d5425)

Signed-off-by: Junqiu Lei <[email protected]>

junqiu-lei added the skip-changelog label May 2, 2024

junqiu-lei force-pushed the fix-macos-ci branch 7 times, most recently from 9cd8cc7 to fe91a0f Compare May 3, 2024 00:21

junqiu-lei changed the title ~~Try to fix build CI failure for MacOS~~ Fix build CI failure on MacOS May 3, 2024

junqiu-lei added the Infrastructure Changes to infrastructure, testing, CI/CD, pipelines, etc. label May 3, 2024

junqiu-lei force-pushed the fix-macos-ci branch from c9ed81c to 19dabe6 Compare May 3, 2024 00:52

jmazanec15 reviewed May 3, 2024

View reviewed changes

junqiu-lei added 2 commits May 3, 2024 09:52

Fix build CI failure for MacOS

6f4fe91

Signed-off-by: Junqiu Lei <[email protected]>

Update runs-on label to macos-12

fd4a585

Signed-off-by: Junqiu Lei <[email protected]>

junqiu-lei force-pushed the fix-macos-ci branch from 19dabe6 to fd4a585 Compare May 3, 2024 16:53

junqiu-lei marked this pull request as ready for review May 3, 2024 17:48

junqiu-lei requested review from VijayanB, heemin32, martin-gaievski, naveentatikonda, navneet1v, ryanbogan and vamshin as code owners May 3, 2024 17:48

ryanbogan approved these changes May 3, 2024

View reviewed changes

jmazanec15 approved these changes May 3, 2024

View reviewed changes

junqiu-lei merged commit 73d5425 into opensearch-project:main May 3, 2024

junqiu-lei deleted the fix-macos-ci branch May 3, 2024 22:27

junqiu-lei added the backport 2.x label May 3, 2024

opensearch-trigger-bot bot pushed a commit that referenced this pull request May 3, 2024

Fix build CI failure on MacOS (#1685)

a65fff1

Signed-off-by: Junqiu Lei <[email protected]> (cherry picked from commit 73d5425)

opensearch-trigger-bot bot mentioned this pull request May 3, 2024

[Backport 2.x] Fix build CI failure on MacOS #1689

Merged

junqiu-lei pushed a commit that referenced this pull request May 6, 2024

Fix build CI failure on MacOS (#1685) (#1689)

23ecce5

jingqimao77-spec pushed a commit to jingqimao77-spec/k-NN that referenced this pull request Mar 15, 2026

Fix build CI failure on MacOS (opensearch-project#1685)

b7ea983

Signed-off-by: Junqiu Lei <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix build CI failure on MacOS#1685

Fix build CI failure on MacOS#1685
junqiu-lei merged 2 commits intoopensearch-project:mainfrom
junqiu-lei:fix-macos-ci

junqiu-lei commented May 2, 2024 •

edited

Loading

Uh oh!

junqiu-lei commented May 3, 2024 •

edited

Loading

Uh oh!

jmazanec15 May 3, 2024

Uh oh!

Uh oh!

jmazanec15 May 3, 2024

Uh oh!

jmazanec15 May 3, 2024

Uh oh!

jmazanec15 May 3, 2024

Uh oh!

jmazanec15 May 3, 2024

Uh oh!

jmazanec15 May 3, 2024

Uh oh!

jmazanec15 May 3, 2024

Uh oh!

junqiu-lei commented May 3, 2024

Uh oh!

junqiu-lei commented May 3, 2024 •

edited

Loading

Uh oh!

jmazanec15 May 3, 2024

Uh oh!

jmazanec15 May 3, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

junqiu-lei commented May 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Check List

Uh oh!

junqiu-lei commented May 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

junqiu-lei commented May 3, 2024

Uh oh!

junqiu-lei commented May 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

junqiu-lei commented May 2, 2024 •

edited

Loading

junqiu-lei commented May 3, 2024 •

edited

Loading

junqiu-lei commented May 3, 2024 •

edited

Loading